////////////////////////////////////////////////////////////////////////////////////////////////////
/// Copyright (c) 2009 - 2010 RacoonStudios
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy of this
/// software and associated documentation files (the "Software"), to deal in the Software
/// without restriction, including without limitation the rights to use, copy, modify, merge,
/// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
/// to whom the Software is furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in all copies or
/// substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
/// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
/// DEALINGS IN THE SOFTWARE.
////////////////////////////////////////////////////////////////////////////////////////////////////

#pragma once
#ifndef assignment_h__
#define assignment_h__

#include "helper/string.h"
#include "helper/keyvaluepair.h"

namespace IO
{

	////////////////////////////////////////////////////////////////////////////////////////////////////
	///	\class	Assignment
	///
	///	\brief	This is a simple representation class for long paths
	///
	///
	///	\date	2010/03/06
	///	\author	khaos                                                            
	////////////////////////////////////////////////////////////////////////////////////////////////////
	class Assignment : public Helper::KeyValuePair<Helper::String, Helper::String>
	{
		public:

			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		Assignment()
			///
			///	\brief	Contructor.
			///
			///	\date	2010/03/06
			///	\author	khaos
			////////////////////////////////////////////////////////////////////////////////////////////////////
			Assignment();

			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		Assignment(const Helper::String & key, const Helper::String & value)
			///
			///	\brief	Constructor.
			///
			///	\date	2010/03/06
			///	\author	khaos   
			///
			/// \param	[in]	key		The scheme of the Assignment.
			///	\param	[in]	value	The real path the scheme represents.
			////////////////////////////////////////////////////////////////////////////////////////////////////
			Assignment(const Helper::String & key, const Helper::String & value);

			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		~Assignment()
			///
			///	\brief	Destructor.
			///
			///	\date	2010/03/06
			///	\author	khaos
			////////////////////////////////////////////////////////////////////////////////////////////////////
			~Assignment();



			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		operator = (const Assignment & rhs)
			///
			///	\brief	Copy operator.
			///
			///	\date	2010/03/06
			///	\author	khaos   
			///
			/// \param	[in]	rhs	The right hand side object.
			////////////////////////////////////////////////////////////////////////////////////////////////////
			void operator = (const Assignment & rhs);

			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		operator == (const Assignment & rhs) const
			///
			///	\brief	Equality operator.
			///
			///	\date	2010/03/06
			///	\author	khaos   
			///
			/// \param	[in]	rhs	The right hand side object.
			///
			///	\return	True if both objects are equal, otherwise false.
			////////////////////////////////////////////////////////////////////////////////////////////////////
			bool operator == (const Assignment & rhs) const;

			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		operator != (const Assignment & rhs) const
			///
			///	\brief	Inequality operator.
			///
			///	\date	2010/03/06
			///	\author	khaos
			///
			/// \param	[in]	rhs	The right hand side object.
			///
			///	\return	True if both objects are inequal, otherwise false.
			////////////////////////////////////////////////////////////////////////////////////////////////////
			bool operator != (const Assignment & rhs) const;




			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		const Helper::String & Scheme() const
			///
			///	\brief	Returns the short scheme for a very long path.
			///
			///	\date	2010/03/06
			///	\author	khaos
			///
			///	\return	The scheme of this Assignment.
			////////////////////////////////////////////////////////////////////////////////////////////////////
			const Helper::String & Scheme() const;

			////////////////////////////////////////////////////////////////////////////////////////////////////
			///	\fn		const Helper::String & Path() const
			///
			///	\brief	Returns the real path of the Assignment.
			///
			///	\date	2010/03/06
			///	\author	khaos
			///
			///	\return	The real path of this Assignment.
			////////////////////////////////////////////////////////////////////////////////////////////////////
			const Helper::String & Path() const;

		protected:
			
		private:

	};

}

#endif // assignment_h__